Skip to content

Enhance README, refactor package, and improve testing setup#1

Merged
francescobianco merged 13 commits intomainfrom
upkeep
Mar 18, 2026
Merged

Enhance README, refactor package, and improve testing setup#1
francescobianco merged 13 commits intomainfrom
upkeep

Conversation

@francescobianco
Copy link
Member

This pull request introduces significant improvements to the project, focusing on developer experience, documentation, and project infrastructure. It adds robust documentation (including usage, contributing, and code of conduct guides), enhances automation with a Makefile and GitHub Actions workflow, and provides example scripts for token generation and API calls. The project metadata has been updated for clarity and correctness, and a conventional commit configuration has been introduced to standardize commit messages.

Documentation and Examples

  • Major overhaul of README.md to provide a comprehensive overview, installation steps, usage examples, features, partner acknowledgments, and licensing details. Also adds badges and partner information. [1] [2]
  • Added docs/contributing.md and docs/code-of-conduct.md to clarify contribution guidelines and establish a code of conduct. [1] [2]
  • Added docs/readme-pypi.md for PyPI-specific documentation.
  • Introduced example scripts: examples/token_generation.py and examples/api_calls.py to demonstrate authentication and API usage. [1] [2]

Project Automation and Tooling

  • Added a Makefile with commands for development, building, publishing, and releasing the package, as well as Poetry setup.
  • Introduced a GitHub Actions workflow (.github/workflows/python.yml) for CI/CD, testing across multiple Python versions, and building the package.

Project Configuration and Metadata

  • Updated pyproject.toml:
    • Changed package name to openapi-python-sdk and version to 0.2.0
    • Updated description, readme, and package paths
    • Added development dependencies and test configuration (pytest)

Developer Experience

  • Added .convcommit file to standardize commit messages using the Conventional Commit format, with detailed instructions and options for the team.

@francescobianco francescobianco merged commit 7ecff4b into main Mar 18, 2026
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant